Skip to content

Repo polish: README standard, demo GIF, social card#5

Merged
conorbronsdon merged 1 commit into
mainfrom
repo-polish
Jun 12, 2026
Merged

Repo polish: README standard, demo GIF, social card#5
conorbronsdon merged 1 commit into
mainfrom
repo-polish

Conversation

@conorbronsdon

Copy link
Copy Markdown
Owner

Brings this repo up to the public-repo polish standard, without touching any functional content or the safe-by-design boundary.

Before

  • Plain H1 plus a glama badge, then straight into the value prop and tool tables
  • No badges row, no demo, no About, no cross-links, no Contributing

After

  • Centered header with a one-line value prop and a badges row (license, TypeScript, npm, MCP, podcast linking chainofthought.show, X)
  • Demo GIF near the top showing a representative list_drafts call and response (sample data, not real account values)
  • About section, sibling cross-links to Transistor-MCP and podcastindex-mcp, Contributing section
  • Disclaimer already present; safe-by-design (no publish/delete/schedule) preserved
  • All existing tool tables, setup steps, and notes preserved verbatim

Assets

  • docs/demo.gif (47 KB) and docs/social-preview.png (1280x640) generated with Pillow

Action for you

GitHub's API can't set the social preview image. Upload docs/social-preview.png manually under Settings > General > Social preview.

🤖 Generated with Claude Code

Add the public-repo polish layer on top of the existing functional docs:
badges row (license, TypeScript, npm, MCP, podcast, X), an About section,
sibling cross-links, and a Contributing section. Add a Pillow-generated
terminal demo GIF and a social preview card under docs/ (sample data only).
All existing tool tables, setup steps, and notes are preserved, including
the safe-by-design boundary.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@conorbronsdon conorbronsdon merged commit a2947ab into main Jun 12, 2026
2 checks passed
@conorbronsdon conorbronsdon deleted the repo-polish branch June 12, 2026 03:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant